Network > Network ACL > API v2ガイド

APIを使用するにはAPIエンドポイントとトークン などが必要です。 API使用準備を参照してAPIの使用に必要な情報を準備します。

セキュリティグループAPIはnetworkタイプエンドポイントを利用します。正確なエンドポイントはトークン発行レスポンスのserviceCatalogを参照します。

タイプ リージョン エンドポイント
network 韓国(ピョンチョン)リージョン https://kr2-api-network-infrastructure.nhncloudservice.com

APIレスポンスにガイドに明示されていないフィールドが表示される場合があります。このようなフィールドはNHN Cloud内部用途に使用され、予告なしに変更される可能性があるため、使用しないでください。

Network ACL

ACLリスト表示

GET /v2.0/acls
X-Auth-Token: {tokenId}

リクエスト

このAPIはリクエスト本文を要求しません。

名前 種類 形式 必須 説明
tokenId Header String O トークンID
sort_dir Query Enum - 照会するACLのソート方向
sort_keyで指定したフィールドを基準にソート
asc、descのいずれか
sort_key Query String - 照会するACLのソートキー
sort_dirで指定した方向でソート
fields Query String - 照会するACLのフィールド名
例) fields=id&fields=name

レスポンス

名前 種類 形式 説明
acls Body Array ACLリストオブジェクト
acls.id Body UUID ACL ID
acls.tenant_id Body String テナントID
acls.description Body String ACLの説明
acls.name Body String ACLの名前
acls.create_at Body String ACL作成時間
acls.update_at Body String ACL更新時間
例 

{
  "acls": [
    {
      "tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
      "description": "Default acl",
      "id": "877b092c-2a31-4509-8d23-deeb02d95633",
      "name": "default",
      "created_at":"2020-11-02T06:51:49Z",
      "updated_at":"2020-11-02T06:51:49Z",
      "revision_number":2
    },
    {
      "tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
      "description": "Default acl2",
      "id": "d3590396-901f-4d90-b8f3-f967831909c2",
      "name": "default2",
      "created_at":"2020-11-05T13:51:43Z",
      "updated_at":"2020-12-10T11:33:12Z",
      "revision_number":2
    }
  ]
}

ACL表示

GET /v2.0/acls/{aclId}
X-Auth-Token: {tokenId}

リクエスト

このAPIはリクエスト本文を要求しません。

名前 種類 形式 必須 説明
tokenId Header String O トークンID
aclId URL UUID O 照会するACL ID
fields Query String - 照会するACLのフィールド名
例) fields=id&fields=name

レスポンス

名前 種類 形式 説明
acl Body Array ACLリストオブジェクト
acl.id Body UUID ACL ID
acl.tenant_id Body String テナントID
acl.description Body String ACLの説明
acl.name Body String ACLの名前
acl.create_at Body String ACL作成時間
acl.update_at Body String ACL更新時間
例 

{
  "acl": 
    {
      "tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
      "description": "Default acl",
      "id": "877b092c-2a31-4509-8d23-deeb02d95633",
      "name": "default",
      "created_at":"2020-11-02T06:51:49Z",
      "updated_at":"2020-11-02T06:51:49Z",
      "revision_number":2
    }
}

ACL作成

POST /v2.0/acls
X-Auth-Token: {tokenId}

リクエスト

名前 種類 形式 必須 説明
tokenId Header String O トークンID
acl Body Array O ACLリストオブジェクト
acl.tenant_id Body String - テナントID
acl.name Body String - ACLの名前(区別のために入れることを推奨)
acl.description Body String - ACLの説明
例 

{
  "acl": 
    {
      "tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
      "description": "Default acl",
      "name": "default"
    }
}

レスポンス

名前 種類 形式 説明
acl Body Array ACLリストオブジェクト
acl.id Body String ACL ID
acl.tenant_id Body String テナントID
acl.name Body String ACLの名前
acl.description Body String ACLの説明
acl.create_at Body String ACL作成時間
acl.update_at Body String ACL更新時間
例 

{
  "acl": 
    {
      "tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
      "description": "Default acl",
      "id": "877b092c-2a31-4509-8d23-deeb02d95633",
      "name": "default",
      "created_at":"2020-11-02T06:51:49Z",
      "updated_at":"2020-11-02T06:51:49Z",
      "revision_number":2
    }
}

ACL削除

DELETE /v2.0/acls/{aclId}
X-Auth-Token: {tokenId}

リクエスト

名前 種類 形式 必須 説明
aclId URL UUID O 削除するACL ID
tokenId Header String O トークンID

レスポンス

このAPIはレスポンス本文を返しません。

ACL修正

既存のACLを修正します(名前と説明のみ修正可能)。

PUT /v2.0/acls/{aclId}
X-Auth-Token: {tokenId}

リクエスト

名前 種類 形式 必須 説明
tokenId Header String O トークンID
aclId URL String O ACL ID
acl Body Array O ACLリストオブジェクト
acl.name Body String - ACLの名前
acl.description Body String - ACLの説明
例 

{
  "acl": 
    {
      "description": "Default acl",
      "name": "default"
    }
}

レスポンス

名前 種類 形式 説明
acl Body Array ACLリストオブジェクト
acl.id Body String ACL ID
acl.tenant_id Body String テナントID
acl.name Body String ACLの名前
acl.description Body String ACLの説明
acl.create_at Body String ACL作成時間
acl.update_at Body String ACL更新時間
例 

{
  "acl": 
    {
      "tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
      "description": "Default acl",
      "id": "877b092c-2a31-4509-8d23-deeb02d95633",
      "name": "default",
      "created_at":"2020-11-02T06:51:49Z",
      "updated_at":"2020-11-02T06:51:49Z",
      "revision_number":2
    }
}

ACL Ruleリスト表示

GET /v2.0/acl_rules/
X-Auth-Token: {tokenId}

リクエスト

このAPIはリクエスト本文を要求しません。

名前 種類 形式 必須 説明
tokenId Header String O トークンID
sort_dir Query Enum - 照会するACL Ruleのソート方向
sort_keyで指定したフィールドを基準にソート
asc、descのいずれか
sort_key Query String - 照会するACL Ruleのソートキー
sort_dirで指定した方向でソート
fields Query String - 照会するACL Ruleのフィールド名
例) fields=id&fields=name

レスポンス

名前 種類 形式 説明
acl_rules Body Array ACL Ruleリストオブジェクト
acl_rules.id Body String ACL Rule ID
acl_rules.tenant_id Body String テナントID
acl_rules.description Body String ACL Ruleの説明
acl_rules.create_at Body String ACL Rule作成時間
acl_rules.update_at Body String ACL Rule更新時間
acl_rules.acl_id Body String ACL ID
acl_rules.protocol Body String protocol(tcp, udp, icmp)
acl_rules.ethertype Body String IPv4で 固定
acl_rules.src_port_range_min Body Integer srcポート範囲の最小値(1～65535)
acl_rules.src_port_range_max Body Integer srcポート範囲の最大値(1～65535)
acl_rules.src_ip Body String src ip
acl_rules.dst_ip Body String dst ip
acl_rules.dst_port_range_max Body Integer dstポート範囲の最小値(1～65535)
acl_rules.dst_port_range_min Body Integer dstポート範囲の最大値(1～65535)
acl_rules.policy Body String allow or deny
acl_rules.order Body Integer ACL Rule適用順序、数字が小さいほど先に適用される(102～32764使用).
例 

{
  "acl_rules": [
    {"remote_group_id":null,"protocol":null,"description":"default deny rule","ethertype":"IPv4","created_at":"2022-12-16T06:58:54Z","src_port_range_max":null,"updated_at":"2022-12-16T06:58:54Z","id":"005a5644-4e43-47fc-b3d9-6c1befe12f7b","src_ip":"0.0.0.0/0","dst_port_range_min":null,"dst_port_range_max":null,"revision_number":0,"tenant_id":"43b53d88b7a54d3aa5472bd800f1cbce","policy":"deny","dst_ip":"0.0.0.0/0","project_id":"43b53d88b7a54d3aa5472bd800f1cbce","order":32765,"acl_id":"5efaec75-8f07-4f5f-83b1-8b4c11c07e0b","src_port_range_min":null},
{"remote_group_id":null,"protocol":null,"description":"","ethertype":"IPv4","created_at":"2020-11-12T01:23:04Z","src_port_range_max":null,"updated_at":"2020-11-12T01:23:04Z","id":"00817eb7-4a3f-45dc-bc8d-8f792bc5a05c","src_ip":"0.0.0.0/0","dst_port_range_min":null,"dst_port_range_max":null,"revision_number":0,"tenant_id":"43b53d88b7a54d3aa5472bd800f1cbce","policy":"allow","dst_ip":"25.0.0.0/0","project_id":"43b53d88b7a54d3aa5472bd800f1cbce","order":125,"acl_id":"f16c042b-a3c6-4bb2-b10a-12b2edb77b01","src_port_range_min":null}
  ]
}

ACL Rule表示

GET /v2.0/acl_rules/{aclRuleId}
X-Auth-Token: {tokenId}

リクエスト

このAPIはリクエスト本文を要求しません。

名前 種類 形式 必須 説明
tokenId Header String O トークンID
aclRuleId URL UUID O 照会するACL Rule ID
fields Query String - 照会するACL Ruleのフィールド名
例) fields=id&fields=name

レスポンス

名前 種類 形式 説明
acl_rule Body Array ACL Ruleリストオブジェクト
acl_rule.id Body String ACL Rule ID
acl_rule.tenant_id Body String テナントID
acl_rule.description Body String ACL Ruleの説明
acl_rule.create_at Body String ACL Rule作成時間
acl_rule.update_at Body String ACL Rule更新時間
acl_rule.acl_id Body String ACL ID
acl_rule.protocol Body String protocol(tcp, udp, icmp)
acl_rule.ethertype Body String IPv4で固定
acl_rule.src_port_range_min Body Integer srcポート範囲の最小値(1～65535)
acl_rule.src_port_range_max Body Integer srcポート範囲の最大値(1～65535)
acl_rule.src_ip Body String src ip
acl_rule.dst_ip Body String dst ip
acl_rule.dst_port_range_max Body Integer dstポート範囲の最小値(1～65535)
acl_rule.dst_port_range_min Body Integer dstポート範囲の最大値(1～65535)
acl_rule.policy Body String allow or deny
acl_rule.order Body Integer ACL Rule適用順序。数字が小さいほど先に適用されます(102～32764使用)。
例 

{
  "acl_rule": 
    {"remote_group_id":null,"protocol":null,"description":"default deny rule","ethertype":"IPv4","created_at":"2022-12-16T06:58:54Z","src_port_range_max":null,"updated_at":"2022-12-16T06:58:54Z","id":"005a5644-4e43-47fc-b3d9-6c1befe12f7b","src_ip":"0.0.0.0/0","dst_port_range_min":null,"dst_port_range_max":null,"revision_number":0,"tenant_id":"43b53d88b7a54d3aa5472bd800f1cbce","policy":"deny","dst_ip":"0.0.0.0/0","project_id":"43b53d88b7a54d3aa5472bd800f1cbce","order":32765,"acl_id":"5efaec75-8f07-4f5f-83b1-8b4c11c07e0b","src_port_range_min":null}
}

ACL Rule作成

POST /v2.0/acl_rules
X-Auth-Token: {tokenId}

リクエスト

名前 種類 形式 必須 説明
tokenId Header String O トークンID
acl_rule Body Array O ACL Ruleリストオブジェクト
acl_rule.tenant_id Body String - テナントID
acl_rule.description Body String - ACL Ruleの説明
acl_rule.acl_id Body String O ACL ID
acl_rule.protocol Body String - protocol(tcp, udp, icmp)
acl_rule.ethertype Body String - IPv4で固定
acl_rule.src_port_range_min Body Integer - srcポート範囲の最小値(1～65535)
acl_rule.src_port_range_max Body Integer - srcポート範囲の最大値(1～65535)
acl_rule.src_ip Body String O src ip
acl_rule.dst_ip Body String O dst ip
acl_rule.dst_port_range_max Body Integer - dstポート範囲の最小値(1～65535)
acl_rule.dst_port_range_min Body Integer - dstポート範囲の最大値(1～65535)
acl_rule.policy Body String O allow or deny
acl_rule.order Body Integer O ACL Rule適用順序。数字が小さいほど先に適用されます(102～32764使用)。
例 

{
  "acl_rule": {"src_ip":"0.0.0.0/0", "tenant_id":"43b53d88b7a54d3aa5472bd800f1cbce",
"policy":"deny","dst_ip":"192.168.0.0/24",
"order":103,"acl_id":"5efaec75-8f07-4f5f-83b1-8b4c11c07e0b"}
}

レスポンス

名前 種類 形式 説明
acl_rule Body Array ACL Ruleリストオブジェクト
acl_rule.id Body String ACL Rule ID
acl_rule.tenant_id Body String テナントID
acl_rule.description Body String ACL Ruleの説明
acl_rule.create_at Body String ACL Rule作成時間
acl_rule.update_at Body String ACL Rule更新時間
acl_rule.acl_id Body String ACL ID
acl_rule.protocol Body String protocol(tcp, udp, icmp)
acl_rule.ethertype Body String IPv4で固定
acl_rule.src_port_range_min Body Integer srcポート範囲の最小値(1～65535)
acl_rule.src_port_range_max Body Integer srcポート範囲の最大値(1～65535)
acl_rule.src_ip Body String src ip
acl_rule.dst_ip Body String dst ip
acl_rule.dst_port_range_max Body Integer dstポート範囲の最小値(1～65535)
acl_rule.dst_port_range_min Body Integer dstポート範囲の最大値(1～65535)
acl_rule.policy Body String allow or deny
acl_rule.order Body Integer ACL Rule適用順序。数字が小さいほど先に適用されます(102～32764使用)。
例 

{
  "acl_rule": 
    {"remote_group_id":null,"protocol":null,"description":"","ethertype":"IPv4","created_at":"2022-12-16T06:58:54Z","src_port_range_max":null,"updated_at":"2022-12-16T06:58:54Z","id":"005a5644-4e43-47fc-b3d9-6c1befe12f7b","src_ip":"0.0.0.0/0","dst_port_range_min":null,"dst_port_range_max":null,"revision_number":0,"tenant_id":"43b53d88b7a54d3aa5472bd800f1cbce","policy":"deny","dst_ip":"192.168.0.0/24","project_id":"43b53d88b7a54d3aa5472bd800f1cbce","order":103,"acl_id":"5efaec75-8f07-4f5f-83b1-8b4c11c07e0b","src_port_range_min":null}
}

ACL Ruleの削除

DELETE /v2.0/acl_rules/{aclRuleId}
X-Auth-Token: {tokenId}

リクエスト

名前 種類 形式 必須 説明
aclRuleId URL UUID O 削除するACL Rule ID
tokenId Header String O トークンID

レスポンス

このAPIはレスポンス本文を返しません。

ACL Ruleの修正

既存ACL Ruleを修正します(説明のみ修正可能です)。

PUT /v2.0/acl_rules/{aclRuleId}
X-Auth-Token: {tokenId}

リクエスト

名前 種類 形式 必須 説明
tokenId Header String O トークンID
aclRuleId URL UUID O 削除するACL Rule ID
acl_rule Body Array O ACL Ruleリストオブジェクト
acl_rule.description Body String O ACL Ruleの説明
例 

{
  "acl_rule": 
    {
      "description": "acl_rule1"
    }
}

レスポンス

名前 種類 形式 説明
acl_rule Body Array ACL Ruleリストオブジェクト
acl_rule.id Body String ACL Rule ID
acl_rule.tenant_id Body String テナントID
acl_rule.description Body String ACL Ruleの説明
acl_rule.create_at Body String ACL Rule作成時間
acl_rule.update_at Body String ACL Rule更新時間
acl_rule.acl_id Body String ACL ID
acl_rule.protocol Body String protocol(tcp, udp, icmp)
acl_rule.ethertype Body String IPv4で固定
acl_rule.src_port_range_min Body Integer srcポート範囲の最小値(1～65535)
acl_rule.src_port_range_max Body Integer srcポート範囲の最大値(1～65535)
acl_rule.src_ip Body String src ip
acl_rule.dst_ip Body String dst ip
acl_rule.dst_port_range_max Body Integer dstポート範囲の最小値(1～65535)
acl_rule.dst_port_range_min Body Integer dstポート範囲の最大値(1～65535)
acl_rule.policy Body String allow or deny
acl_rule.order Body Integer ACL Rule適用順序。数字が小さいほど先に適用されます(102～32764使用)。
例 

{
  "acl_rule": 
    {"remote_group_id":null,"protocol":null,"description":"default deny rule","ethertype":"IPv4","created_at":"2022-12-16T06:58:54Z","src_port_range_max":null,"updated_at":"2022-12-16T06:58:54Z","id":"005a5644-4e43-47fc-b3d9-6c1befe12f7b","src_ip":"0.0.0.0/0","dst_port_range_min":null,"dst_port_range_max":null,"revision_number":0,"tenant_id":"43b53d88b7a54d3aa5472bd800f1cbce","policy":"deny","dst_ip":"0.0.0.0/0","project_id":"43b53d88b7a54d3aa5472bd800f1cbce","order":32765,"acl_id":"5efaec75-8f07-4f5f-83b1-8b4c11c07e0b","src_port_range_min":null}
}

ACLバインディングリスト表示

GET /v2.0/acl_bindings/
X-Auth-Token: {tokenId}

リクエスト

このAPIはリクエスト本文を要求しません。

名前 種類 形式 必須 説明
tokenId Header String O トークンID
sort_dir Query Enum - 照会するACLバインディングのソート方向
sort_keyで指定したフィールドを基準にソート
asc、descのいずれか
sort_key Query String - 照会するACLバインディングのソートキー
sort_dirで指定した方向でソート
fields Query String - 照会するACLバインディングのフィールド名
例) fields=id&fields=name

レスポンス

名前 種類 形式 説明
acl_bindings Body Array ACLバインディングリストオブジェクト
acl_bindings.id Body String ACLバインディングID
acl_bindings.tenant_id Body String テナントID
acl_bindings.acl_id Body String NetworkとバインディングされるACL ID
acl_bindings.network_id Body String ACLとバインディングされるNetwork ID
例 

{
  "acl_bindings": [ 
    {
      "tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
      "id": "877b092c-2a31-4509-8d23-deeb02d95633",
      "acl_id":"2a61e4ab-b7f7-4323-a399-7e121996f6bb",
      "network_id":"56abace2-98b5-4767-ae5e-a2e2ab44d49a"
    },
    {
      "tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
      "id": "edb544dc-377d-4bbd-8516-435ad45b47ad",
      "acl_id":"9b0bb5bd-f457-483f-9adb-987bce2bed89",
      "network_id":"0bb5e696-65cf-49d8-a545-d9d814e3c4b2"
    }
   ]
}

ACLバインディング表示

GET /v2.0/acl_bindings/{aclBindingId}
X-Auth-Token: {tokenId}

リクエスト

このAPIはリクエスト本文を要求しません。

名前 種類 形式 必須 説明
tokenId Header String O トークンID
aclBindingId URL UUID O 照会するACLバインディングID
fields Query String - 照会するACLバインディングのフィールド名
例) fields=id&fields=name

レスポンス

名前 種類 形式 説明
acl_binding Body Array ACLバインディングリストオブジェクト
acl_binding.id Body String ACLバインディングID
acl_binding.tenant_id Body String テナントID
acl_binding.acl_id Body String NetworkとバインディングされるACL ID
acl_binding.network_id Body String ACLとバインディングされるNetwork ID
例 

{
  "acl_binding": 
    {
      "tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
      "id": "877b092c-2a31-4509-8d23-deeb02d95633",
      "acl_id":"2a61e4ab-b7f7-4323-a399-7e121996f6bb",
      "network_id":"56abace2-98b5-4767-ae5e-a2e2ab44d49a"
    }
}

ACLバインディングの作成

POST /v2.0/acl_bindings
X-Auth-Token: {tokenId}

リクエスト

名前 種類 形式 必須 説明
tokenId Header String O トークンID
acl_binding Body Array O ACLバインディングリストオブジェクト
acl_binding.tenant_id Body String - テナントID
acl_binding.network_id Body String O Network ID
acl_binding.acl_id Body String O ACL ID
例 

{
  "acl_binding": 
    {
      "tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
      "acl_id":"2a61e4ab-b7f7-4323-a399-7e121996f6bb",
      "network_id":"56abace2-98b5-4767-ae5e-a2e2ab44d49a"
    }
}

レスポンス

名前 種類 形式 説明
acl_binding Body Array ACLバインディングリストオブジェクト
acl_binding.id Body String ACLバインディングID
acl_binding.tenant_id Body String テナントID
acl_binding.acl_id Body String NetworkとバインディングされるACL ID
acl_binding.network_id Body String ACLとバインディングされるNetwork ID
例 

{
  "acl_binding": 
    {
      "tenant_id": "19eeb40d58684543aef29cbb5ebfe8f0",
      "id": "877b092c-2a31-4509-8d23-deeb02d95633",
      "acl_id":"2a61e4ab-b7f7-4323-a399-7e121996f6bb",
      "network_id":"56abace2-98b5-4767-ae5e-a2e2ab44d49a"
    }
}

ACLバインディングの削除

DELETE /v2.0/acl_bindings/{aclBindingId}
X-Auth-Token: {tokenId}

リクエスト

名前 種類 形式 必須 説明
aclBindingId URL UUID O 削除するACLバインディングID
tokenId Header String O トークンID

レスポンス

このAPIはレスポンス本文を返しません。

目次
TOP